feat(x/staking): allow zero unbonding time #19779

ocnc · 2024-03-18T23:07:43Z

Description

Allows for zero unbonding time

Closes: #XXXX

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

included the correct type prefix in the PR title
confirmed ! in the type prefix if API or client breaking change
targeted the correct branch (see PR Targeting)
provided a link to the relevant issue or specification
reviewed "Files changed" and left comments if necessary
included the necessary unit and integration tests
added a changelog entry to CHANGELOG.md
updated the relevant documentation or specification, including comments for documenting Go code
confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

confirmed the correct type prefix in the PR title
confirmed all author checklist items have been addressed
reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

Bug Fixes
- Ensured unbonding time cannot be set to a negative value, enhancing the validation process.
New Features
- Added the ability to set unbonding_time to zero, providing more flexibility to users.
- Improved error handling by returning errors instead of logging in certain hook calls, enhancing reliability.
- Updated methods to return errors instead of panicking, ensuring smoother error management.

coderabbitai · 2024-03-18T23:07:49Z

Walkthrough

The changes aim to enhance the flexibility of the staking module by expanding the validation criteria for the unbonding time. Previously required to be strictly positive, the unbonding time can now be zero or positive, providing more options for setting unbonding times.

Changes

File	Summary
`x/staking/types/params.go`	Updated `validateUnbondingTime` to allow unbonding time >= 0.
`x/staking/CHANGELOG.md`	- Added ability to set `unbonding_time` to zero.
	- Changed error handling for certain hook calls to return errors.
	- Updated various methods to return errors instead of panicking.
`x/staking/keeper/msg_server_test.go`	Updated error message assertion in `TestMsgUpdateParams`.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit-tests for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit tests for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit tests.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
The JSON schema for the configuration file is available here.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

coderabbitai

Review Status

Actionable comments generated: 1

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between ed6b3ab and 4b9c691.

Files selected for processing (1)

x/staking/types/params.go (1 hunks)

x/staking/types/params.go

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 4b9c691 and c5a30d5.

Files selected for processing (1)

x/staking/types/params.go (1 hunks)

Files skipped from review as they are similar to previous changes (1)

x/staking/types/params.go

tac0turtle

thanks this makes sense

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between c5a30d5 and 76b3362.

Files selected for processing (1)

x/staking/CHANGELOG.md (1 hunks)

Additional comments: 1

x/staking/CHANGELOG.md (1)

34-34: The changelog entry for allowing unbonding_time to be set to zero is clear and concise, directly linking to the PR for more details.

julienrbrt

utACK

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 76b3362 and 0a4806e.

Files selected for processing (1)

x/staking/keeper/msg_server_test.go (1 hunks)

Additional comments: 1

x/staking/keeper/msg_server_test.go (1)

1173-1173: The error message assertion in TestMsgUpdateParams has been updated from "unbonding time must be positive" to "unbonding time must not be negative." This change aligns with the PR's objective to allow the unbonding time parameter to be set to zero, indicating that the validation logic now accepts zero or positive values for unbonding time.

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 0a4806e and b792cd1.

Files selected for processing (2)

x/staking/CHANGELOG.md (1 hunks)
x/staking/keeper/msg_server_test.go (1 hunks)

Files skipped from review as they are similar to previous changes (1)

x/staking/keeper/msg_server_test.go

Additional comments: 1

x/staking/CHANGELOG.md (1)

34-34: The entry for allowing unbonding_time to be set to zero is correctly placed under the "Improvements" section and follows the changelog's format. However, it's essential to ensure that the documentation elsewhere in the project is updated to reflect this change, especially in user-facing materials where the implications of setting unbonding_time to zero are explained.

allow zero unbonding time

4b9c691

ocnc requested a review from a team as a code owner March 18, 2024 23:07

github-actions bot added the C:x/staking label Mar 18, 2024

update error

c5a30d5

coderabbitai bot reviewed Mar 18, 2024

View reviewed changes

x/staking/types/params.go Show resolved Hide resolved

coderabbitai bot reviewed Mar 18, 2024

View reviewed changes

tac0turtle approved these changes Mar 19, 2024

View reviewed changes

tac0turtle assigned tac0turtle and sontrinh16 Mar 19, 2024

add changelog

76b3362

ocnc changed the title ~~[Feature]: allow zero unbonding time~~ feat(x/staking): allow zero unbonding time Mar 19, 2024

coderabbitai bot reviewed Mar 19, 2024

View reviewed changes

erorr message update in test

0a4806e

julienrbrt approved these changes Mar 19, 2024

View reviewed changes

coderabbitai bot reviewed Mar 19, 2024

View reviewed changes

Merge branch 'main' into ocnc/allow-zero-unbonding-time

b792cd1

coderabbitai bot reviewed Mar 19, 2024

View reviewed changes

julienrbrt added this pull request to the merge queue Mar 19, 2024

Merged via the queue into cosmos:main with commit a1bfe5d Mar 19, 2024
55 of 57 checks passed

coderabbitai bot mentioned this pull request Apr 22, 2024

chore: sync main changelogs with v0.47.11, v0.50.6, modules and x/tx #20125

Merged

12 tasks

This was referenced May 3, 2024

refactor: fetch CometInfo from service #20238

Merged

refactor!(staking): remove comet crypto as a dep #20295

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(x/staking): allow zero unbonding time #19779

feat(x/staking): allow zero unbonding time #19779

ocnc commented Mar 18, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 18, 2024 •

edited

Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

coderabbitai bot left a comment

coderabbitai bot left a comment

tac0turtle left a comment

coderabbitai bot left a comment

julienrbrt left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

feat(x/staking): allow zero unbonding time #19779

feat(x/staking): allow zero unbonding time #19779

Conversation

ocnc commented Mar 18, 2024 • edited by coderabbitai bot Loading

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

coderabbitai bot commented Mar 18, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

tac0turtle left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

julienrbrt left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

ocnc commented Mar 18, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 18, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)